﻿// Copyright 2017 the original author or authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

using System;
using System.Collections.Generic;

namespace Steeltoe.Common.Converter
{
    /// <summary>
    /// Generic converter interface for converting between two or more types
    /// </summary>
    public interface IGenericConverter
    {
        /// <summary>
        /// Gets the source and target types this converter can convert between.
        /// </summary>
        ISet<(Type Source, Type Target)> ConvertibleTypes { get; }

        /// <summary>
        /// Convert the source object to the target type.
        /// </summary>
        /// <param name="source">the object to convert; the source can be null</param>
        /// <param name="sourceType">the type of the source that should be used during the conversion.
        /// Can be null, and defaults to the type of the source object</param>
        /// <param name="targetType">the type we are converting to</param>
        /// <returns>the converted object</returns>
        object Convert(object source, Type sourceType, Type targetType);
    }
}
